Resource URL: /platform/<<version=3>>/cluster/nodes/<LNN>/state

    Overview: This resource applies the standard collection pattern to
              individual nodes.  LNN in the resource path is the node lnn ID.

     Methods: GET

********************************************************************************

Method GET: Retrieve node state information.

       URL: GET /platform/<<version=3>>/cluster/nodes/<LNN>/state

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "total": {
          "type": "integer", 
          "description": "The total number of nodes responding."
        }, 
        "nodes": {
          "items": {
            "type": "object", 
            "description": "Node state information (reported and modifiable).", 
            "properties": {
              "status": {
                "required": false, 
                "minimum": 0, 
                "type": "integer", 
                "description": "Status of the HTTP response from this node if not 200.  If 200, this field does not appear.", 
                "maximum": 4294967295
              }, 
              "servicelight": {
                "type": "object", 
                "description": "Node service light state.", 
                "properties": {
                  "supported": {
                    "type": "boolean", 
                    "description": "This node supports a service light."
                  }, 
                  "enabled": {
                    "required": true, 
                    "type": "boolean", 
                    "description": "The node service light state (True = on)."
                  }, 
                  "valid": {
                    "type": "boolean", 
                    "description": "The node service light state is valid (False = Error)."
                  }, 
                  "present": {
                    "type": "boolean", 
                    "description": "This node has a service light."
                  }
                }
              }, 
              "smartfail": {
                "type": "object", 
                "description": "Node smartfail state.", 
                "properties": {
                  "smartfailed": {
                    "type": "boolean", 
                    "description": "This node is smartfailed (soft_devs)."
                  }, 
                  "dead": {
                    "type": "boolean", 
                    "description": "This node is dead (dead_devs)."
                  }, 
                  "down": {
                    "type": "boolean", 
                    "description": "This node is down (down_devs)."
                  }, 
                  "readonly": {
                    "type": "boolean", 
                    "description": "This node is readonly (ro_devs)."
                  }, 
                  "in_cluster": {
                    "type": "boolean", 
                    "description": "This node is in the cluster (all_devs)."
                  }, 
                  "shutdown_readonly": {
                    "type": "boolean", 
                    "description": "This node is shutdown readonly (down_devs)."
                  }
                }
              }, 
              "readonly": {
                "type": "object", 
                "description": "Node readonly state.", 
                "properties": {
                  "status": {
                    "type": [
                      "string", 
                      "integer"
                    ], 
                    "description": "The current read-only mode status description for the node."
                  }, 
                  "enabled": {
                    "type": "boolean", 
                    "description": "The current read-only user mode status for the node. NOTE: If read-only mode is currently disallowed for this node, it will remain read/write until read-only mode is allowed again. This value only sets or clears any user-specified requests for read-only mode. If the node has been placed into read-only mode by the system, it will remain in read-only mode until the system conditions which triggered read-only mode have cleared."
                  }, 
                  "value": {
                    "type": "integer", 
                    "description": "The current read-only value (enumerated bitfield) for the node."
                  }, 
                  "valid": {
                    "type": "boolean", 
                    "description": "The read-only state values are valid (False = Error)."
                  }, 
                  "mode": {
                    "type": "boolean", 
                    "description": "The current read-only mode status for the node."
                  }, 
                  "allowed": {
                    "type": "boolean", 
                    "description": "The current read-only mode allowed status for the node."
                  }
                }
              }, 
              "lnn": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Logical node number of the node reporting this information.", 
                "maximum": 4294967295
              }, 
              "error": {
                "required": false, 
                "type": "string", 
                "description": "Error message, if the HTTP status returned from this node was not 200."
              }, 
              "id": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Node ID of the node reporting this information.", 
                "maximum": 4294967295
              }
            }
          }, 
          "type": "array", 
          "description": "The responses from the individual nodes involved in this request."
        }, 
        "errors": {
          "items": {
            "type": "object", 
            "properties": {
              "status": {
                "minimum": 0, 
                "type": "integer", 
                "description": "HTTP Status code returned by this node.", 
                "maximum": 4294967295
              }, 
              "message": {
                "type": "string", 
                "description": "More detailed description of the error."
              }, 
              "code": {
                "type": "string", 
                "description": "The general meaning of the status code."
              }, 
              "lnn": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Logical node number of the node reporting this error.", 
                "maximum": 4294967295
              }
            }
          }, 
          "type": "array", 
          "description": "A list of errors encountered by the individual nodes involved in this request, or an empty list if there were no errors."
        }
      }
    }
  ]
}
